home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / general / hdf / docs / hdfvset.lha / HDFVset.ch3 < prev    next >
Text File  |  1994-01-10  |  5KB  |  201 lines
  1. 3.1    NCSA HDF Vset
  2.  
  3.  
  4. Vset Utilities    3.1
  5.  
  6.  
  7. National Center for Supercomputing Applications
  8.  
  9. November 1990
  10.  
  11.                                                                 
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19. Chapter 3    Vset Utilities
  20.  
  21.  
  22.  
  23. Chapter Overview
  24. vshow
  25. Synopsis
  26. vshow Description
  27. Bugs
  28. vmake
  29. Synopsis
  30. vmake Description
  31. Creating New Vgroups
  32. Creating New Vdatas
  33. Creating Links
  34. Bugs
  35.  
  36. Chapter Overview
  37.  
  38. This chapter describes  the utilities available in NCSA HDF Vset.
  39.  
  40.  
  41. vshow
  42.  
  43. vshow lists vset information in an HDF file.
  44.  
  45.  
  46. Synopsis
  47. Ñ    vshow file   [options]
  48.  
  49.  
  50. vshow Description
  51. For a HDF file containing vset elements, vshow lists and displays 
  52. information on all the vgroups in that file, in the order stored, 
  53. followed by the vdatas.
  54.  
  55. Options:
  56. -    dumps all the data stored in ALL vdatas,  without 
  57.     formatting.
  58.  
  59. +    as for the '-' option, but formatted, i.e. each record of a vdata 
  60.     is separated from the other, on a new line.
  61.  
  62. -n    dumps data for the vdata with reference number n, 
  63.     unformatted.
  64.  
  65. +n    dumps data for the vdata with reference number n, 
  66.     formatted.
  67.  
  68. Information about vdatas that are not linked to any vgroup are 
  69. preceded by an "L". 
  70.  
  71. vshow is primarily used to examine the contents of vsets. But 
  72. vshow is also useful for converting vsets in HDF files into ASCII. 
  73. The utility outputs full data dumps of vdatas through standard 
  74. output, but outputs general information through standard error.
  75.  
  76. Hence,
  77.  
  78.     vshow myfile.hdf +4 > text.file
  79.  
  80. will create an ASCII file containing formatted ASCII data from the 
  81. vdata with reference number 4. 
  82.  
  83.  
  84. Bugs
  85. For full vdata dump, you must specify only one vdata or all vdatas.
  86.  
  87.  
  88. vmake
  89.  
  90. vmake creates vgroups, and vdatas and links them in an HDF file.
  91.  
  92.  
  93. Synopsis
  94. Ñ    vmake file vgroup-name
  95.     creates a vgroup.
  96.  
  97. Ñ    vmake file vdata-name format
  98.     creates a vdata.
  99.  
  100. Ñ     vmake file -l vgroup-ref ref1 ref2...refn 
  101. links vgroups and vdatas.
  102.  
  103.  
  104. vmake Description
  105. vmake is a general utility for generating vsets in an HDF file. 
  106. You may use vmake in three different ways:  (1) for creating new 
  107. vgroups, (2) for storing data into new vdatas, and (3) for creating 
  108. links among vgroups and vdatas.
  109.  
  110. Invoking vmake with no arguments provides help.
  111.  
  112. Return value:  If vmake is successful it prints a positive number; 
  113. otherwise, a negative number is printed.
  114.  
  115.  
  116. Creating New Vgroups
  117. vmake creates a new vgroup, named vgroup-name in the HDF file 
  118. file. This new vgroup will not overwrite any information within 
  119. the file, if that file exists. If it doesn't, vmake creates a new file. 
  120. Upon successful creation, the program prints the reference number 
  121. of that vgroup.
  122.  
  123.  
  124. Creating New Vdatas
  125. vmake creates a new vdata, named vdata-name in the HDF file 
  126. file, and converts and stores ASCII data *from standard input*  
  127. in the vdata according to  field specifications in format.
  128.  
  129.     format has the form field1=conv,field2=conv,.. 
  130.  
  131. where
  132.  
  133.     field1, field2 
  134.  
  135.     denotes fields you would define for that vdata (e.g., PX for  
  136.     floating-point x-values, PLIST for connectivity data).
  137.     
  138.     conv
  139.  
  140.     is a single character specifying the field type. Thus, it is one of 
  141. the following:
  142.  
  143.         f - float
  144.         d - integer
  145.         l - long
  146.         c - character.
  147.  
  148. Each field type may be optionally preceded by a repetition-number, 
  149. i.e., the number of data items of the same type that together 
  150. comprise one instance of the field. For example, the repetition 
  151. number "3" in PLIST=3d specifies that each instance of the field 
  152. called PLIST will consist of 3 integers.
  153.  
  154. Note that a stream of ASCII data from standard input is expected.
  155.  
  156. Examples:
  157.  
  158. vmake vset.hdf "coordinates" "PX=f,PY=f,PZ=f" 
  159. < pos.dat
  160.  
  161. will create a vdata named "coordinates" containing 3 fields 
  162. "PX","PY" and "PZ", each of type float. In this case, a stream of 
  163. ASCII floating-point numbers is read from the ASCII file pos.dat.
  164.  
  165.     myprog | vmake vset.hdf "simulation5" "DENSITY=f"
  166.  
  167. will create a vdata named simulation5 containing a single field 
  168. of type float named DENSITY. In this case, the output from the 
  169. program myprog (a stream of ASCII floating-point numbers) is 
  170. piped into vmake.
  171.  
  172.  
  173. Creating Links
  174. vmake in this context allows one or several vdatas or vgroups to be 
  175. inserted (linked) to a vgroup. All vgroups and vdata are identified 
  176. by their reference numbers. 
  177.  
  178. vgroup-ref is the reference number of the vgroup into which the 
  179. other vgroups or vdatas are to be inserted. 
  180.  
  181. ref1 ref2...refn are the reference numbers of those vgroups or 
  182. vdatas to be inserted.
  183.  
  184. Reference numbers of existing vgroups and vdatas  can be 
  185. displayed using vshow.
  186.  
  187. vmake permits the creation of empty vgroups, but not empty 
  188. vdatas.Vgroups and vdatas may be created in any order by the 
  189. user. However, to perform linking, the vgroups and vdatas 
  190. involved must already exist.
  191.  
  192.  
  193. Bugs
  194. vmake does not check for cycles, and will happily allow you to 
  195. insert a vgroup into itself. 
  196.  
  197. It is legal to create multiple vgroups or vdatas with identical 
  198. names.
  199.  
  200.  
  201.